﻿//-----------------------------------------------------------------------
// <copyright file="FlagUtility.cs" company="Nathan Miller">
// Copyright (c) Nathan Miller.
//
// Permission is hereby granted, free of charge, to any person obtaining
// a copy of this software and associated documentation files (the
// "Software"), to deal in the Software without restriction, including
// without limitation the rights to use, copy, modify, merge, publish,
// distribute, sublicense, and/or sell copies of the Software, and to
// permit persons to whom the Software is furnished to do so, subject to
// the following conditions:
// 
// The above copyright notice and this permission notice shall be
// included in all copies or substantial portions of the Software.
// 
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
// EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
// MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
// NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
// LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
// OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
// WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
// </copyright>
//-----------------------------------------------------------------------
namespace TileTool.Common
{
    /// <summary>
    /// Utility class which wraps common flag operations.
    /// </summary>
    public static class FlagUtility
    {
        /// <summary>
        /// Set or unset a flag in the input uint.
        /// </summary>
        /// <param name="set">True if we want to set the flag or false if we want to clear it.</param>
        /// <param name="input">Input flag data.</param>
        /// <param name="flag">Flag to set or clear.</param>
        public static void Set(bool set, ref uint input, uint flag)
        {
            if (set)
            {
                input |= flag;
            }
            else
            {
                input &= ~flag;
            }
        }

        /// <summary>
        /// Tests if the passed flags are set in the input flags.
        /// </summary>
        /// <param name="input">Input flags to test against.</param>
        /// <param name="flag">Flags to test.</param>
        /// <returns>Returns true if all of the test flags are set in the input.</returns>
        public static bool IsSet(uint input, uint flag)
        {
            return (input & flag) == flag;
        }
    }
}
